docs(README): fix token format, create-flag, and MCP install drift#26
Merged
Conversation
Five small docs/reality drifts surfaced by a fresh-user devex agent run that follows only public docs: 1. Token examples used `sk_live_...` / `sk_test_...` — these are Stripe-style prefixes that don't match what the API actually issues. Real DevHelm tokens are `dh_live_...` / `dh_test_...` (verified against a working prod token). Updated three call sites: - `devhelm auth login --token sk_live_...` - `export DEVHELM_API_TOKEN=sk_live_...` - `devhelm auth context create staging --token sk_test_...` 2. `monitors create` example used `--interval 30`, but the actual flag exposed by `src/lib/resources.ts` is `--frequency`. The example as written errors with `Nonexistent flag: --interval`. Bumped the example value to 60s while I was there (the API minimum for HTTP monitors). 3. The "AI Agents" section advertised `npm install -g @devhelm/mcp-server`, but the MCP server has only ever shipped as the Python package `devhelm-mcp-server` on PyPI (not on npm). Updated to `pip install devhelm-mcp-server` (with a `uvx devhelm-mcp-server` no-install alternative). Same identity-drift fix as devhelmhq/mono#358. No code changes — README only. Refs: pre-launch DevEx agent reports. Co-authored-by: Cursor <cursoragent@cursor.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Five small docs/reality drifts surfaced by a fresh-user DevEx agent run that follows only public docs:
1. Token format examples used Stripe-style `sk_live_` prefix
The README's auth-login, env-var, and staging-context examples all used `sk_live_…` / `sk_test_…`, but the API issues `dh_live_…` / `dh_test_…` (verified against a real prod token). Updated three call sites:
2. `monitors create` example used a flag that doesn't exist
The example used `--interval 30`, but the actual flag exposed by `src/lib/resources.ts` is `--frequency`. The example as written errors with `Nonexistent flag: --interval`. Bumped the example value to `60` (the API minimum for HTTP monitors).
3. AI-Agents section advertised the wrong MCP install
`npm install -g @devhelm/mcp-server` — but the MCP server has only ever shipped as the Python package `devhelm-mcp-server` on PyPI, not on npm. Updated to `pip install devhelm-mcp-server` with a `uvx devhelm-mcp-server` no-install alternative. Same identity-drift fix as devhelmhq/mono#358.
Test plan
Refs: pre-launch DevEx agent reports — synthesis at `/tmp/devex-cli-test/SYNTHESIS.md`
Made with Cursor